<?php
/**
 * Ruth Library
 * $Id: Omni.php 2 2008-01-17 02:59:56Z baron314159@yahoo.com $
 *
 * LICENSE
 *
 * Copyright (c) 2007, Chris Utz
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the Impact Lab nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY CHRIS UTZ ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL CHRIS UTZ BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @category   Ruth
 * @package    Ruth_Channel
 * @author     Chris Utz <chris@chrisutz.com>
 * @copyright  2007 Chris Utz <chris@chrisutz.com>
 * @license    http://www.opensource.org/licenses/bsd-license.php    New BSD License
 * @version    $Revision: 2 $
 */

/**
 * @see Ruth_Validate_Abstract
 */
require_once 'Ruth/Validate/Abstract.php';

/**
 * If a Validator class needs to "see" the values of other fields registered to
 * a channel, it should extend this class.  When a validator extends from this
 * class and is added to a field, the channel will handle it specially, giving
 * it read-only access to the other field values.
 *
 * @category   Ruth
 * @package    Ruth_Channel
 * @subpackage Ruth_Channel_Validate
 * @author     Chris Utz <chris@chrisutz.com>
 * @license    http://www.opensource.org/licenses/bsd-license.php    New BSD License
 * @since      1.0
 * @version    $Revision: 2 $
 */
abstract class Ruth_Channel_Validate_Omni extends Ruth_Validate_Abstract
{
    /**
     * An ArrayObject of Ruth_Channel_Field objects.
     * 
     * @var ArrayObject
     */
    private $_fields;

    /**
     * Used by Ruth_Channel to pass in an object allowing access to other
     * fields in the channel.
     *
     * @param ArrayObject $fields
     */
    public function setFields(ArrayObject $fields)
    {
        $this->_fields = $fields;
    }

    /**
     * Gets a field's value or returns $default if the field specified by $name
     * does not exist in the field list.
     *
     * @param string $name
     * @param mixed $default
     * @return mixed The value of the field or $default
     */
    public function getFieldValue($name, $default=null)
    {
        if (isset($this->_fields[$name])) {
            return $this->_fields[$name]->getValue();
        } else {
            return $default;
        }
    }

    /**
     * Returns the ArrayObject containing the fields in the channel.
     *
     * @return ArrayObject
     */
    public function getFields()
    {
        return $this->_fields;
    }
}
 
// vim: sw=4:ts=4:sts=4:et
